Enhanced Nested Service Model
Diagrams
Enhanced Nested Service Model
Classes
ServiceAtomicDescriptor
Parent class: ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_serviceAtomicInstance |
ServiceAtomicInstance |
0..* |
OpenModelAttribute
|
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. |
_resourceDesc (resourcespecification) |
ResourceDesc |
0..* |
OpenModelAttribute
|
Resource components of constituting a serivce descriptor. |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceAtomicInstance
Parent class: ServiceInstance
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_resourceInstance |
ResourceInstance |
0..* |
OpenModelAttribute
|
Resource instance components of constituting a service instance. |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceCompositeDescriptor
ServcieCompositeDescriptor is used to model the design time representation of a service component or network service.
Parent class: ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_serviceDescriptor |
ServiceDescriptor |
0..* |
OpenModelAttribute
|
Describe the nested relationship between multiple Service Descriptors. |
_serviceCompositeInstance |
ServiceCompositeInstance |
0..* |
OpenModelAttribute
|
An implementation of composite Service corresponding to a ServiceCompositeDescriptor. |
_resourceDesc (resourcespecification) |
ResourceDesc |
0..* |
OpenModelAttribute
|
Resource components of constituting a serivce descriptor. |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceCompositeInstance
Parent class: ServiceInstance
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
_resourceInstance |
ResourceInstance |
0..* |
OpenModelAttribute
|
Resource instance components of constituting a service instance. |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceDescriptor
ServiceDescriptor is used to model the design time representation of a service.
Parent class: DesignEntity
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
serviceInvariantId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Constant identifier of the service model. |
serviceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Versioned identifier of the service model (this uuid is changed for every major version of the service) |
name |
String |
1 |
OpenModelAttribute
Preliminary |
The name of the service model designed. |
description |
String |
1 |
OpenModelAttribute
Preliminary |
The description of the service model designed. |
category |
String |
1..* |
OpenModelAttribute
Preliminary |
A predefined list which identifies the construct’s category. There is a predefined list of service categories. |
version |
String |
1 |
OpenModelAttribute
Preliminary |
The service model version. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
icon |
String |
1 |
OpenModelAttribute
Preliminary |
The icon path of the service. |
attachment |
Attachment |
0..* |
OpenModelAttribute
Preliminary |
|
isShared |
Boolean |
1 |
OpenModelAttribute
Preliminary |
Describe whether this service descriptor is shared or not in the service design. |
lifecycleManagementScript |
ServiceLifecycleManagementScript |
0..* |
OpenModelAttribute
Preliminary |
Includes a list of events and corresponding management scripts performed for the Service. |
class8 |
CustomizedKPIGroup |
0..1 |
OpenModelAttribute
|
|
SNSSAIId |
Identifier |
0..1 |
OpenModelAttribute
Experimental |
|
validFor |
TimePeriod |
0..1 |
OpenModelAttribute
Preliminary |
The period during which the design entity is valid. |
status |
String |
1 |
OpenModelAttribute
Preliminary |
The condition of the specification, such s active, inactive, or planned. |
name |
String |
1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
ServiceInstance
ServiceInstance is used to model the run time representation of a service.
Parent class: OperationalEntity
Applied stereotypes:
OpenModelClass
support: MANDATORY
Preliminary
Attribute Name |
Type |
Mult. |
Stereotypes |
Description |
serviceInstanceId |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Uniquely identifies this instance of a service. Uniquely identifies this instance of a service. |
serviceInstanceName |
String |
0..1 |
OpenModelAttribute
Preliminary |
The name assigned to the service-instance. |
serviceType |
String |
0..1 |
OpenModelAttribute
Preliminary |
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”. |
serviceRole |
String |
1 |
OpenModelAttribute
Preliminary |
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”. |
selfLink |
Uri |
1 |
OpenModelAttribute
Preliminary |
URL to endpoint where more details can be gotten. |
orchestrationStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Orchestration status of the service instance. |
nsStatus |
String |
1 |
OpenModelAttribute
Preliminary |
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). |
instanceSharingNumber |
Integer |
0..1 |
OpenModelAttribute
Preliminary |
Record the number of services that are using this service instance. Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. |
name |
String |
0..1 |
OpenModelAttribute
Preliminary |
Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). |
description |
String |
0..1 |
OpenModelAttribute
Preliminary |
Defines a textual free-form description of the object. |
id |
Identifier |
1 |
OpenModelAttribute
Preliminary |
Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. |
Associations
ServiceCompositeInstanceHasServiceInstance
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceInstance |
shared |
Not navig. |
1..* |
ServiceInstance |
OpenModelAttribute
|
|
_servicecompositeinstance |
none |
Not navig. |
1..* |
ServiceCompositeInstance |
OpenModelAttribute
|
SerivceCompositeDescriptorMadeAvailableAsServiceCompositeInstance
An implementation of composite Service corresponding to a ServiceCompositeDescriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceCompositeInstance |
shared |
Not navig. |
0..* |
ServiceCompositeInstance |
OpenModelAttribute
|
|
_servicecompositedescriptor |
none |
Not navig. |
1 |
ServiceCompositeDescriptor |
OpenModelAttribute
|
ServiceCompositeDescriptorComprisedOfServiceDescriptor
Describe the nested relationship between multiple Serive Descriptors.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceDescriptor |
shared |
Not navig. |
0..* |
ServiceDescriptor |
OpenModelAttribute
|
|
servicecompositedescriptor |
none |
Not navig. |
0..* |
ServiceCompositeDescriptor |
OpenModelAttribute
|
ServiceAtomicDescriptorMadeAvailableAsServiceAtomicInstance
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_serviceAtomicInstance |
shared |
Not navig. |
0..* |
ServiceAtomicInstance |
OpenModelAttribute
|
|
_serviceatomicdescriptor |
none |
Not navig. |
1 |
ServiceAtomicDescriptor |
OpenModelAttribute
|
ServiceAtomicDescriptorReferencesResourceDesc
Resource components of constituting a serivce descriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceDesc (resourcespecification) |
none |
Navig. |
0..* |
ResourceDesc |
Resource components of constituting a serivce descriptor. |
OpenModelAttribute
|
_serviceatomicdescriptor |
none |
Not navig. |
0..* |
ServiceAtomicDescriptor |
OpenModelAttribute
|
ServiceAtomicInstanceReferencesResourceInstance
Resource instance components of constituting a serivce instance.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceInstance |
none |
Navig. |
0..* |
ResourceInstance |
Resource instance components of constituting a service instance. |
OpenModelAttribute
|
_serviceatomicinstance |
none |
Not navig. |
0..* |
ServiceAtomicInstance |
OpenModelAttribute
|
ServiceCompositeInstanceReferencesResourceInstance
Resource instance components of constituting a serivce instance.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceInstance |
none |
Navig. |
0..* |
ResourceInstance |
Resource instance components of constituting a service instance. |
OpenModelAttribute
|
_servicecompositeinstance |
none |
Not navig. |
0..* |
ServiceCompositeInstance |
OpenModelAttribute
|
ServiceCompositeDescriptorReferencesResourceDesc
Resource components of constituting a serivce descriptor.
Applied stereotypes:
Preliminary
Attribute Name |
Aggreg. |
Navig. |
Mult. |
Type |
Description |
Stereotypes |
_resourceDesc (resourcespecification) |
none |
Navig. |
0..* |
ResourceDesc |
Resource components of constituting a serivce descriptor. |
OpenModelAttribute
|
_service compositedescriptor |
none |
Not navig. |
0..* |
ServiceCompositeDescriptor |
OpenModelAttribute
|
Data Types
ServiceLifecycleManagementScript
The LifeCycleManagementScript information element specifies a script for the service.
Applied stereotypes:
Preliminary
Attribute Name |
Type |
Mult. |
Access |
Stereotypes |
Description |
event |
ServiceLcmEvent |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point. Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point. |
lcmTransitionEvent |
String |
0..* |
RW |
OpenModelAttribute
Preliminary |
Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. |
script |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. |
scriptDsl |
String |
1 |
RW |
OpenModelAttribute
Preliminary |
Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. |
scriptInput |
KeyValuePair |
0..* |
RW |
OpenModelAttribute
Preliminary |
Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. Note: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change. |
Enumerations
ServiceLcmEvent
Contains Enumeration Literals:
EVENT_START_DEPLOYMENT:
EVENT_END_DEPLOYMENT:
EVENT_START_CONFIGURATION:
EVENT_END_CONFIGURATION:
EVENT_START_TERMINATION:
EVENT_END_TERMINATION:
EVENT_START_DEPLOYMENT:
EVENT_END_DEPLOYMENT:
EVENT_START_CONFIGURATION:
EVENT_END_CONFIGURATION:
EVENT_START_TERMINATION:
EVENT_END_TERMINATION: